Skip to main content

Get available drivers

GET {{base_url}}/delivery-orders/drivers/available

Description

This API endpoint is used to find available drivers.

Request:

Headers:

NameDescription
tenantIdA string identifying the tenant.
countryCodeA string representing the country code.

Responses:

  • 200 OK:
{
"status": true,
"statusCode": 0,
"message": "Available drivers found.",
"data": {},
"errors": []
}

  • 400 Bad Request:
    • Media Type: application/json
      • Example Value:
{
"status": false,
"statusCode": 400,
"message": "Invalid request.",
"errors": [
{
"message": "Invalid request.",
"descriptiveMessage": "The request is invalid. Please check the provided data."
}
]
}

  • 404 Not Found:
{
"status": false,
"statusCode": 404,
"message": "Drivers not found.",
"errors": [
{
"message": "Drivers not found.",
"descriptiveMessage": "No available drivers were found."
}
]
}


LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /delivery-orders/drivers/available \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!